com.highdeal.rangetable.hci
Class RangeTableClassOutColumnModel

java.lang.Object
  extended by com.highdeal.rangetable.hci.RangeTableClassOutColumnModel
All Implemented Interfaces:
IXMLMarshallable, XMLMapping, XMLMarshallable

public class RangeTableClassOutColumnModel
extends java.lang.Object
implements IXMLMarshallable, XMLMapping

This Java class represents an output attribute of a range table class.

See Also:
RangeTableClassModel

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:complexType name="OutColumnType">
   <xs:sequence>
     <xs:element name="description" type="DescriptionType" minOccurs="1" maxOccurs="1" />
     <xs:choice>
       <xs:element name="string" />
       <xs:element name="singleNumber" />
       <xs:element name="cumulativeNumber" />
       <xs:element name="rangeSizeCumulativeNumber" />
     </xs:choice>
   </xs:sequence>
   <xs:attribute name="name" type="xs:string"/>
 </xs:complexType>


Nested Class Summary
static class RangeTableClassOutColumnModel.OutRangeTableClassType
          This enumeration lists all the types of out columns in the range tables and subscriber range tables; You set up this type in the range table class referred by these business data tables.
 
Constructor Summary
RangeTableClassOutColumnModel()
           
 
Method Summary
 void addCharacterData(java.lang.String cData)
          Adds character data to the content element.
 void addChild(java.lang.String tagName, XMLMarshallable child)
          Adds a child to the object, the child representing the marshallable object which must be added to the element.
 RangeTableClassOutColumnModel duplicate()
           
 java.lang.Class<?> getClass(java.lang.String nsUri, java.lang.String tag, XMLAttributes atts)
          Returns the Java class for a specified XML tag and its attributes in a namespace.
 java.lang.String getDescription()
          Gets the range table description.
 java.lang.String getName()
          Gets the name of the out column.
 RangeTableClassOutColumnModel.OutRangeTableClassType getType()
          Gets the type of the out column.
 void marshal(XMLOutputter output)
          Deprecated. 
 void marshalAttributes(XMLOutputter output)
          Gives an XML representation of the attributes of an object.
 void marshalChildren(XMLOutputter output)
          Gives an XML representation of the child objects of an object.
 void setAttributes(XMLAttributes atts)
          Sets the attributes of the XML representation of the element being processed.
 void setDescription(java.lang.String description)
          Sets the description of the range table.
 void setName(java.lang.String name)
          Sets the name of the out column.
 void setType(RangeTableClassOutColumnModel.OutRangeTableClassType type)
          Sets the type of the out column.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

RangeTableClassOutColumnModel

public RangeTableClassOutColumnModel()
Method Detail

getName

public java.lang.String getName()
Gets the name of the out column.

Returns:
A string that contains the name of the out column

setName

public void setName(java.lang.String name)
Sets the name of the out column.

Parameters:
name - The name of the out column

getDescription

public java.lang.String getDescription()
Gets the range table description.

Returns:
A string that contains the description of the range table

setDescription

public void setDescription(java.lang.String description)
Sets the description of the range table.

Parameters:
description - The description to set to this range table

getType

public RangeTableClassOutColumnModel.OutRangeTableClassType getType()
Gets the type of the out column.

Returns:
The type of the out column
See Also:
setType(OutRangeTableClassType), RangeTableClassOutColumnModel.OutRangeTableClassType

setType

public void setType(RangeTableClassOutColumnModel.OutRangeTableClassType type)
Sets the type of the out column.

Parameters:
type - The type of the out column
See Also:
RangeTableClassOutColumnModel.OutRangeTableClassType

duplicate

public RangeTableClassOutColumnModel duplicate()

addCharacterData

public void addCharacterData(java.lang.String cData)
Description copied from interface: XMLMarshallable
Adds character data to the content element.

Specified by:
addCharacterData in interface XMLMarshallable
Parameters:
cData - The character data to be added

addChild

public void addChild(java.lang.String tagName,
                     XMLMarshallable child)
Description copied from interface: XMLMarshallable
Adds a child to the object, the child representing the marshallable object which must be added to the element.

Specified by:
addChild in interface XMLMarshallable
Parameters:
tagName - The name of tag for the child
child - The child to be added

setAttributes

public void setAttributes(XMLAttributes atts)
Description copied from interface: XMLMarshallable
Sets the attributes of the XML representation of the element being processed.

Specified by:
setAttributes in interface XMLMarshallable
Parameters:
atts - The XML attributes of the current element

marshalAttributes

public void marshalAttributes(XMLOutputter output)
Description copied from interface: IXMLMarshallable
Gives an XML representation of the attributes of an object.

Specified by:
marshalAttributes in interface IXMLMarshallable
Parameters:
output - The XML output to marshal the object attributes into

marshalChildren

public void marshalChildren(XMLOutputter output)
Description copied from interface: IXMLMarshallable
Gives an XML representation of the child objects of an object.

Specified by:
marshalChildren in interface IXMLMarshallable
Parameters:
output - The XML output to marshal the child objects into

marshal

@Deprecated
public void marshal(XMLOutputter output)
Deprecated. 

Description copied from interface: XMLMarshallable
Gives an XML representation of this object, including its children.

Specified by:
marshal in interface IXMLMarshallable
Specified by:
marshal in interface XMLMarshallable
Parameters:
output - The XML output to marshal the object into

getClass

public java.lang.Class<?> getClass(java.lang.String nsUri,
                                   java.lang.String tag,
                                   XMLAttributes atts)
Description copied from interface: XMLMapping
Returns the Java class for a specified XML tag and its attributes in a namespace.

Specified by:
getClass in interface XMLMapping
Parameters:
nsUri - The unique resource identifier of the namespace of the XML tag
tag - The local part of the XML tag
atts - The attributes of the XML tag
Returns:
A Java class with a default constructor

Document Published: October 2015 (SAP CC 4.0 SP10 and Later)